home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / pyshared / AppInstall / widgets / ReleaseNotesViewer.py < prev    next >
Encoding:
Python Source  |  2009-03-31  |  7.5 KB  |  192 lines
  1. # ReleaseNotesViewer.py
  2. #  
  3. #  Copyright (c) 2006 Sebastian Heinlein
  4. #  
  5. #  Author: Sebastian Heinlein <sebastian.heinlein@web.de>
  6. #
  7. #  This modul provides an inheritance of the gtk.TextView that is 
  8. #  aware of http URLs and allows to open them in a browser.
  9. #  It is based on the pygtk-demo "hypertext".
  10. # 
  11. #  This program is free software; you can redistribute it and/or 
  12. #  modify it under the terms of the GNU General Public License as 
  13. #  published by the Free Software Foundation; either version 2 of the
  14. #  License, or (at your option) any later version.
  15. # 
  16. #  This program is distributed in the hope that it will be useful,
  17. #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19. #  GNU General Public License for more details.
  20. # 
  21. #  You should have received a copy of the GNU General Public License
  22. #  along with this program; if not, write to the Free Software
  23. #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24. #  USA
  25.  
  26.  
  27. import pygtk
  28. import gtk
  29. import pango
  30. import subprocess
  31. import os
  32.  
  33. class ReleaseNotesViewer(gtk.TextView):
  34.     def __init__(self, notes=None):
  35.         """Init the ReleaseNotesViewer as an Inheritance of the gtk.TextView.
  36.            Load the notes into the buffer and make links clickable"""
  37.         # init the parent
  38.         gtk.TextView.__init__(self)
  39.         # global hovering over link state
  40.         self.hovering = False
  41.         self.first = True
  42.         # setup the buffer and signals
  43.         self.set_property("editable", False)
  44.         self.set_cursor_visible(False)
  45.         self.buffer = gtk.TextBuffer()
  46.         self.set_buffer(self.buffer)
  47.         self.connect("event-after", self.event_after)
  48.         self.connect("motion-notify-event", self.motion_notify_event)
  49.         self.connect("visibility-notify-event", self.visibility_notify_event)
  50.         #self.buffer.connect("changed", self.search_links)
  51.         self.buffer.connect_after("insert-text", self.on_insert_text)
  52.         # search for links in the notes and make them clickable
  53.         if notes != None:
  54.             self.buffer.set_text(notes)
  55.  
  56.     def tag_link(self, start, end, url):
  57.         """Apply the tag that marks links to the specified buffer selection"""
  58.         tag = self.buffer.create_tag(None, foreground="blue",
  59.                                      underline=pango.UNDERLINE_SINGLE)
  60.         tag.set_data("url", url)
  61.         self.buffer.apply_tag(tag , start, end)
  62.  
  63.     def on_insert_text(self, buffer, iter_end, text, *args):
  64.         """Search for http URLs in newly inserted text  
  65.            and tag them accordingly"""
  66.         iter = buffer.get_iter_at_offset(iter_end.get_offset() - len(text))
  67.         iter_real_end = buffer.get_end_iter()
  68.         for protocol in ["http://", "https://"]:
  69.             while True:
  70.                 # search for the next URL in the buffer
  71.                 ret = iter.forward_search(protocol, 
  72.                                       gtk.TEXT_SEARCH_VISIBLE_ONLY,
  73.                                       iter_end)
  74.                 # if we reach the end break the loop
  75.                 if not ret:
  76.                     break
  77.                 # get the position of the protocol prefix
  78.                 (match_start, match_end) = ret
  79.                 match_tmp = match_end.copy()
  80.                 while True:
  81.                     # extend the selection to the complete URL
  82.                     if match_tmp.forward_char():
  83.                         text =  match_end.get_text(match_tmp)
  84.                         if text in (" ", ")", "]", "\n", "\t",">","!"):
  85.                             break
  86.                     else:
  87.                         break
  88.                     match_end = match_tmp.copy()
  89.                 # call the tagging method for the complete URL
  90.                 url = match_start.get_text(match_end)
  91.                 tags = match_start.get_tags()
  92.                 tagged = False
  93.                 for tag in tags:
  94.                     url = tag.get_data("url")
  95.                     if url != "":
  96.                         tagged = True
  97.                         break
  98.                 if tagged == False:
  99.                     self.tag_link(match_start, match_end, url)
  100.                 # set the starting point for the next search
  101.                 iter = match_end
  102.  
  103.     def event_after(self, text_view, event):
  104.         """callback for mouse click events"""
  105.         # we only react on left mouse clicks
  106.         if event.type != gtk.gdk.BUTTON_RELEASE:
  107.             return False
  108.         if event.button != 1:
  109.             return False
  110.  
  111.         # try to get a selection
  112.         try:
  113.             (start, end) = self.buffer.get_selection_bounds()
  114.         except ValueError:
  115.             pass
  116.         else:
  117.             if start.get_offset() != end.get_offset():
  118.                 return False
  119.  
  120.         # get the iter at the mouse position
  121.         (x, y) = self.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
  122.                                               int(event.x), int(event.y))
  123.         iter = self.get_iter_at_location(x, y)
  124.         
  125.         # call open_url if an URL is assigned to the iter
  126.         tags = iter.get_tags()
  127.         for tag in tags:
  128.             url = tag.get_data("url")
  129.             if url != None:
  130.                 self.open_url(url)
  131.                 break
  132.  
  133.     def open_url(self, url):
  134.         """Open the specified URL in a browser"""
  135.         # Find an appropiate browser
  136.         if os.path.exists('/usr/bin/gnome-open'):
  137.             command = ['gnome-open', url]
  138.         else:
  139.             command = ['x-www-browser', url]
  140.  
  141.         # Avoid to run the browser as user root
  142.         if os.getuid() == 0 and os.environ.has_key('SUDO_USER'):
  143.             command = ['sudo', '-u', os.environ['SUDO_USER']] + command
  144.  
  145.         subprocess.Popen(command)
  146.  
  147.     def motion_notify_event(self, text_view, event):
  148.         """callback for the mouse movement event, that calls the
  149.            check_hovering method with the mouse postition coordiantes"""
  150.         x, y = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
  151.                                                  int(event.x), int(event.y))
  152.         self.check_hovering(x, y)
  153.         self.window.get_pointer()
  154.         return False
  155.     
  156.     def visibility_notify_event(self, text_view, event):
  157.         """callback if the widgets gets visible (e.g. moves to the foreground)
  158.            that calls the check_hovering method with the mouse position
  159.            coordinates"""
  160.         (wx, wy, mod) = text_view.window.get_pointer()
  161.         (bx, by) = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET, wx,
  162.                                                      wy)
  163.         self.check_hovering(bx, by)
  164.         return False
  165.  
  166.     def check_hovering(self, x, y):
  167.         """Check if the mouse is above a tagged link and if yes show
  168.            a hand cursor"""
  169.         _hovering = False
  170.         # get the iter at the mouse position
  171.         iter = self.get_iter_at_location(x, y)
  172.         
  173.         # set _hovering if the iter has the tag "url"
  174.         tags = iter.get_tags()
  175.         for tag in tags:
  176.             url = tag.get_data("url")
  177.             if url != None:
  178.                 _hovering = True
  179.                 break
  180.  
  181.         # change the global hovering state
  182.         if _hovering != self.hovering or self.first == True:
  183.             self.first = False
  184.             self.hovering = _hovering
  185.             # Set the appropriate cursur icon
  186.             if self.hovering:
  187.                 self.get_window(gtk.TEXT_WINDOW_TEXT).\
  188.                         set_cursor(gtk.gdk.Cursor(gtk.gdk.HAND2))
  189.             else:
  190.                 self.get_window(gtk.TEXT_WINDOW_TEXT).\
  191.                         set_cursor(gtk.gdk.Cursor(gtk.gdk.LEFT_PTR))
  192.